Net Settled Sales by Transaction Report
The Net Settled Sales by Transaction report, used primarily for fiscal reconciliation, includes all settled and conveyed transactions (deposits and refunds), including Direct Debit transactions. You can schedule this report based upon either activity (post) or settlement (funds transfer) day. Worldpay produces this report daily.
The following fields may contain commas within the data: Issuing Bank, Address1, Address2, and AVS Response Message. We can modify your profile such that the reports use spaces within the data instead of commas Please ask your Relationship Manager for additional information.
Filename Syntax
The syntax of the report filename is:
Financial_Detail_NssByTxnByActivityDate${rptCategoryId}${currencyAlpha}${conveyed}${neg ativeRefund}_${organizationId}_${targetDay}
or
Financial_Detail_NssByTxnBySettlementDate${rptCategoryId}${currencyAlpha}${negativeRefund}_${organizationId}_${targetDay}
where
-
rptCategoryId
is the ID of the Reporting Group to which the report applies. If the report is not filtered by Reporting Group, this value is replaced by a 0. -
currencyAlpha
is the 3-digit ISO 4217 currency code for the currency of the transactions included in the report. If the report includes all currencies, this value is replaced by a 0. -
conveyed
is a flag indicating if the report should include conveyed transactions (applies only to Activity Date based reports) -
negativeRefund
is a flag indicating if refunds contained in the report appear preceeded by a minus sign (-) -
organizationId
is the ID of the parent merchant organization -
targetDay
is the date for which the data applies (for example, 20120615 for June 15, 2012)
Report Structure
The table below provides information about the fields included in the report. The report fields are in the order presented in the table.
A data type of Signed Decimal (17,2) with a Max Size of 21 is defined as:
17 digits + decimal point + 2 digits + sign.
Field Name |
Data Type |
Max Size |
Description |
---|---|---|---|
Report Group |
Alphanumeric |
50 |
The Reporting Group category to which the transaction belongs. |
Merchant |
Alphanumeric |
50 |
The name of the parent organization (or division) that submitted the transaction. |
Activity Date |
Date (MM/dd/yyyy) |
10 |
The original date of the submitted transaction. |
Settlement Date |
Date (MM/dd/yyyy) |
10 |
The date that Worldpay initiated the funds transfer to your merchant account. |
Vantiv Payment ID |
Numeric (with preceding apostrophe) |
20 |
The unique identifier automatically assigned to each transaction by Worldpay and associated with the transaction. |
Parent Vantiv Payment ID |
Numeric (with preceding apostrophe) |
20 |
The payment Id for the parent transaction. For example, if the transaction was a capture, this is the payment Id for the associated Authorization transaction. |
Merchant Order Number |
Alphanumeric |
256 |
The merchant-designated identifier for this transaction (i.e., value of the orderId element). |
Txn Type |
Alphanumeric |
50 |
The type of transaction. Possible values are:
|
Purchase Currency |
Alphanumeric |
5 |
The currency used for the purchase, designated by a three-character abbreviation of the country. |
Purchase Amt |
Signed Decimal (17,2) |
21 |
The total dollar amount of the purchase. |
Settlement Currency |
Alphanumeric |
5 |
The currency used for the settlement, designated by a three-character abbreviation of the country. |
Settlement Amt |
Signed Decimal (17,2) |
21 |
The settlement amount for this transaction. |
Payment Type |
Alphanumeric |
50 |
The method of payment for this transaction. The possible values are:
|
Account Suffix |
Alphanumeric |
4 |
The account number suffix that the customer used for this transaction. Regardless of account permissions, only the last four digits are visible for credit cards, and the last three digits for eChecks, unless the Direct Debit account number is <4 digits. In this case this field contains XXXX. |
Bin |
Alphanumeric |
6 |
The bank identification number, which is the first six digits of the credit card number used for the transaction. This uniquely identifies the institution that issued the credit card to the card holder. All Discover Cards return a value of discov for the BIN. Also, the BIN field is blank for PayPal and Direct Debit transaction. |
Response Reason Message |
Alphanumeric |
80 |
The transaction response returned by Worldpay for this transaction. If the transaction was declined, this message provides a reason. |
Batch ID |
Numeric (with preceding apostrophe) |
20 |
The unique number automatically assigned by Worldpay for the batch associated with the transaction. |
Session ID |
Numeric (with preceding apostrophe) |
20 |
The unique number automatically assigned by the system for the session associated with the transaction. |
ARN |
Alphanumeric (with preceding apostrophe) |
23 |
The Acquirer Reference Number (ARN) that uniquely identifies this transaction with the Card Networks. |
Interchange Rate |
Alphanumeric |
100 |
The Interchange Qualification rate for this transaction, as designated by the Card Networks. |
Customer ID |
Alphanumeric |
50 |
The unique identifier for the purchaser associated with the transaction. |
Merchant Transaction ID |
Alphanumeric |
25 |
The identifier specified by the merchant for this transaction. This value corresponds to the id attribute (id="value") of the transaction. |
Affiliate |
Alphanumeric |
25 |
The merchant-specified identifier used to track transactions associated with your affiliate organizations. |
Campaign |
Alphanumeric |
25 |
The merchant-specified identifier used to track transactions associated with specific marketing campaigns. |
Merchant Grouping ID |
Alphanumeric |
25 |
The merchant-specified identifier for grouping transactions by an additional transaction level ID outside of Affiliate or Campaign. |
Token Number |
Numeric |
50 |
The reference number (token) issued by Worldpay to replace the submitted credit card number or Direct Debit account number. |
Transaction Processing Timestamp GMT |
Timestamp (MM/dd/yyyy HH:mm:ss) |
23 |
The date and time (GMT) the transaction was processed by Worldpay |
Approximate Interchange Fee Amount |
Decimal (17,2) |
20 |
The approximate interchange fee amount assessed for the transaction by parties other than Worldpay (pass-through fees). |
Interchange Flat Rate |
Decimal |
17 |
The flat rate of interchange for this payment. |
Interchange Percent Rate |
Decimal |
10 |
The percent rate of interchange for this payment. |
Funding Method |
Alphanumeric |
50 |
Defines the Funding Method for the transaction as either Settled or Conveyed. |
Issuing Bank |
Alphanumeric |
100 |
The name of the Issuing Bank. |
Billing Descriptor |
Alphanumeric |
25 |
The text shown on the customer bill. This is either the default (hard-coded billing descriptor), or the value designated in the transaction (soft billing descriptor. |
Merchant ID |
Alphanumeric |
50 |
The value of the merchantId element/attribute submitted in the cnpAPI transaction. |
Presenter |
Alphanumeric |
50 |
The short name of the Presenter used to transmit the transaction to Worldpay. |
Vantiv cnpAPI Reporting Group |
Alphanumeric |
50 |
The Reporting Group submitted as the reportGroup attribute of this transaction. |
Customer Reference |
Alphanumeric |
17 |
The reference string used by the cardholder to track the order. |
Txn Secondary Amt |
Signed Decimal (17,2) |
19 |
The portion of the purchase amount that is directed to a third party. |
Txn Secondary Settlement Amt |
Signed Decimal (17,2) |
19 |
The portion of the settlement amount that is directed to a third party. |
Requested Auth Amount |
Signed Decimal (17,2) |
12 |
The requested amount from the Authorization. |
Original Auth Code |
Alphanumeric |
6 |
The original Authorization approval code. |
Customer Name |
Alphanumeric |
100 |
The name of the cardholder as submitted in the Bill to information. |
Address Line 1 |
Alphanumeric |
35 |
The first line of the street address of the cardholder as submitted in the Bill to information. |
Address Line 2 |
Alphanumeric |
35 |
The second line of the street address of the cardholder as submitted in the Bill to information. |
City |
Alphanumeric |
35 |
The city of the cardholder as submitted in the Bill to information. |
State |
Alphanumeric |
30 |
The state of the cardholder as submitted in the Bill to information. |
Postal Code |
Alphanumeric |
20 |
The postal code of the cardholder as submitted in the Bill to information. |
Fraud Checksum Response Code |
Alphanumeric |
10 |
The card validation response code. Possible values are:
|
Fraud Checksum Response Message |
Alphanumeric |
100 |
A text explanation of the Fraud Checksum Response Code. |
AVS Response Code |
Alphanumeric |
2 |
The response code representing the result of the Address Verification check. For a full list of codes, please refer to Appendix A of the Worldpay eComm cnpAPI Reference Guide. |
AVS Response Message |
Alphanumeric |
100 |
A text explanation of the AVS Response Code. |
Token Response Code |
Alphanumeric |
3 |
A 3-digit code indicating the results of a transaction involving the conversion or attempted conversion of an account number to a token. |
Token Response Message |
Alphanumeric |
512 |
A text explanation of the Token Response Code. |
PINless Debit Network |
Alphanumeric |
10 |
The PINless Debit network on which the transaction was processed. |
Merchant Category Code |
Alphanumeric |
4 |
The Merchant Category Code associated with the merchant submitting the transaction, or associated with the transaction, if you use dynamic MCCs. |
Billing Profile Id |
Numeric |
19 |
The unique identifier of the merchant’s Billing Profile within our system. |
Worldpay Transfer Id |
Numeric |
36 |
The unique transfer identifier for the transaction. |